docs/Board - Sparky.md

   1 # Board - Sparky
   2
   3 The Sparky is a very low cost and very powerful board.
   4
   5 * 3 hardware serial ports.
   6 * Built-in serial port inverters which allows S.BUS receivers to be used without external inverters.
   7 * USB (can be used at the same time as the serial ports).
   8 * 10 PWM outputs.
   9 * Dedicated PPM/SerialRX input pin.
  10 * MPU9150 I2C Acc/Gyro/Mag
  11 * Baro
  12
  13 Tested with revision 1 & 2 boards.
  14
  15 ## TODO
  16
  17 * Display (via Flex port)
  18 * SoftSerial - though having 3 hardware serial ports makes it a little redundant.
  19 * Airplane PWM mappings.
  20
  21 # Voltage and current monitoring (ADC support)
  22
  23 Voltage monitoring is possible when enabled via PWM9 pin and current can be monitored via PWM8 pin. The voltage divider and current sensor need to be connected externally. The vbatscale cli parameter need to be adjusted to fit the sensor specification. For more details regarding the sensor hardware you can check here: https://github.com/TauLabs/TauLabs/wiki/User-Guide:-Battery-Configuration
  24
  25 # Flashing
  26
  27 ## Via Device Firmware Upload (DFU, USB) - Windows
  28
  29 These instructions are for flashing the Sparky board under Windows using DfuSE.
  30 Credits go to Thomas Shue (Full video of the below steps can be found here: https://www.youtube.com/watch?v=I4yHiRVRY94)
  31
  32 Required Software:
  33 DfuSE Version 3.0.2 (latest version 3.0.4 causes errors): http://code.google.com/p/multipilot32/downloads/detail?name=DfuSe.rar
  34 STM VCP Driver 1.4.0: http://www.st.com/web/en/catalog/tools/PF257938
  35
  36 A binary file is required for DFU, not a .hex file.  If one is not included in the release then build one as follows.
  37
  38 ```
  39 Unpack DfuSE and the STM VCP Drivers into a folder on your Hardrive
  40 Download the latest Sparky release (cleanflight_SPARKY.hex) from:
  41 https://github.com/cleanflight/cleanflight/releases and store it on your Hardrive
  42
  43 In your DfuSE folder go to BIN and start DfuFileMgr.exe
  44 Select: "I want to GENERATE a DFUfile from S19,HEX or BIN files" press OK
  45 Press: "S19 or Hex.."
  46 Go to the folder where you saved the cleanflight_SPARKY.hex file, select it  and press open
  47 (you might need to change the filetype in the DfuSE explorer window to "hex Files (*.hex)" to be able to see the file)
  48 Press: "Generate" and select the .dfu output file and location
  49 If all worked well you should see " Success for 'Image for lternate Setting 00 (ST..)'!"
  50
  51 ```
  52
  53 Put the device into DFU mode by powering on the sparky with the bootloader pins temporarily bridged.  The only light that should come on is the blue PWR led.
  54
  55 Check the windows device manager to make sure the board is recognized correctly.
  56 It should show up as "STM Device in DFU mode" under Universal Serial Bus Controllers
  57
  58 If it shows up as "STMicroelectronics Virtual COM" under Ports (COM & LPT) instead then the board is not in DFU mode. Disconnect the board, short the bootloader pins again while connecting the board.
  59
  60 If the board shows up as "STM 32 Bootloader" device in the device manager, the drivers need to be updated manually.
  61 Select the device in the device manager, press "update drivers", select "manual update drivers" and choose the location where you extracted the STM VCP Drivers, select "let me choose which driver to install". You shoud now be able to select either the STM32 Bootloader driver or the STM in DFU mode driver. Select the later and install.
  62
  63
  64 Then flash the binary as below.
  65
  66 ```
  67 In your DfuSE folder go to BIN and start DfuSeDemo.exe
  68 Select the Sparky Board (STM in DFU Mode) from the Available DFU and compatible HID Devices drop down list
  69 Press "Choose.." at the bootom of the window and select the .dfu file created in the previous step
  70 "File correctly loaded" should appear in the status bar
  71 Press "Upgrade" and confirm with "Yes"
  72 The status bar will show the upload progress and confirm that the upload is complete at the end
  73
  74 ```
  75
  76 Disconnect and reconnect the board from USB and continue to configure it via the Cleanflight configurator as per normal
  77
  78
  79 ## Via Device Firmware Upload (DFU, USB) - Mac OS X / Linux
  80
  81 These instructions are for dfu-util, tested using dfu-util 0.7 for OSX from the OpenTX project.
  82
  83 http://www.open-tx.org/2013/07/15/dfu-util-07-for-mac-taranis-flashing-utility/
  84
  85 A binary file is required for DFU, not a .hex file.  If one is not included in the release then build one as follows.
  86
  87 ```
  88 make TARGET=SPARKY clean
  89 make TARGET=SPARKY binary
  90 ```
  91
  92 Put the device into DFU mode by powering on the sparky with the bootloader pins temporarily bridged.  The only light that should come on is the blue PWR led.
  93
  94 Run 'dfu-util -l' to make sure the device is listed, as below.
  95
  96 ```
  97 $ dfu-util -l
  98 dfu-util 0.7
  99
 100 Copyright 2005-2008 Weston Schmidt, Harald Welte and OpenMoko Inc.
 101 Copyright 2010-2012 Tormod Volden and Stefan Schmidt
 102 This program is Free Software and has ABSOLUTELY NO WARRANTY
 103 Please report bugs to dfu-util@lists.gnumonks.org
 104
 105 Found DFU: [0483:df11] devnum=0, cfg=1, intf=0, alt=0, name="@Internal Flash  /0x08000000/128*0002Kg"
 106 Found DFU: [0483:df11] devnum=0, cfg=1, intf=0, alt=1, name="@Option Bytes  /0x1FFFF800/01*016 e"
 107 ```
 108
 109 Then flash the binary as below.
 110
 111 ```
 112 dfu-util -D obj/cleanflight_SPARKY.bin --alt 0 -R -s 0x08000000
 113 ```
 114
 115 The output should be similar to this:
 116
 117 ```
 118 dfu-util 0.7
 119
 120 Copyright 2005-2008 Weston Schmidt, Harald Welte and OpenMoko Inc.
 121 Copyright 2010-2012 Tormod Volden and Stefan Schmidt
 122 This program is Free Software and has ABSOLUTELY NO WARRANTY
 123 Please report bugs to dfu-util@lists.gnumonks.org
 124
 125 Opening DFU capable USB device... ID 0483:df11
 126 Run-time device DFU version 011a
 127 Found DFU: [0483:df11] devnum=0, cfg=1, intf=0, alt=0, name="@Internal Flash  /0x08000000/128*0002Kg"
 128 Claiming USB DFU Interface...
 129 Setting Alternate Setting #0 ...
 130 Determining device status: state = dfuERROR, status = 10
 131 dfuERROR, clearing status
 132 Determining device status: state = dfuIDLE, status = 0
 133 dfuIDLE, continuing
 134 DFU mode device DFU version 011a
 135 Device returned transfer size 2048
 136 No valid DFU suffix signature
 137 Warning: File has no DFU suffix
 138 DfuSe interface name: "Internal Flash  "
 139 Downloading to address = 0x08000000, size = 76764
 140 ......................................
 141 File downloaded successfully
 142 can't detach
 143 Resetting USB to switch back to runtime mode
 144
 145 ```
 146 On Linux you might want to take care that the modemmanager isn't trying to use your sparky as modem getting it into bootloader mode while doing so. In doubt you probably want to uninstall it. It could also be good idea to get udev fixed. It looks like teensy did just that -> http://www.pjrc.com/teensy/49-teensy.rules (untested)
 147
 148 To make a full chip erase you can use a file created by
 149 ```
 150 dd if=/dev/zero of=zero.bin bs=1 count=262144
 151 ```
 152 This can be used by dfu-util.
 153
 154 ## Via SWD
 155
 156 On the bottom of the board there is an SWD header socket onto switch a JST-SH connector can be soldered.
 157 Once you have SWD connected you can use the st-link or j-link tools to flash a binary.
 158
 159 See Sparky schematic for CONN2 pinouts.
 160
 161 ## TauLabs bootloader
 162
 163 Flashing cleanflight will erase the TauLabs bootloader, this is not a problem and can easily be restored using the st flashloader tool.
 164
 165 # Serial Ports
 166
 167 | Value | Identifier   | RX        | TX         | Notes                                                          |
 168 | ----- | ------------ | --------- | ---------- | -------------------------------------------------------------- |
 169 | 1     | USB VCP      | RX (USB)  | TX (USB)   |                                                                |
 170 | 2     | USART1       | RX / PB7  | TX / PB6   | Conn1 / Flexi Port.                                            |
 171 | 3     | USART2       | RX / PA3  | PWM6 / PA2 | On RX is on INPUT header.  Best port for Serial RX input       |
 172 | 4     | USART3       | RX / PB11 | TX / PB10  | RX/TX is on one end of the 6-pin header above the PWM outputs. |
 173
 174 USB VCP *can* be used at the same time as other serial ports (unlike Naze32).
 175
 176 All USART ports all support automatic hardware inversion which allows direct connection of serial rx receivers like the FrSky X4RSB - no external inverter needed.
 177
 178 # Sonar Connections
 179
 180 | Pin  | Signal | Function        | Resistor    |
 181 | ---- | ------ | --------------- | ----------- |
 182 | PWM6 | PA2    | Trigger pin     | 1K Ohm      |
 183 | PWM7 | PB1    | Echo pin        | 1K Ohm      |
 184
 185 WARNING: Both PWM6 and PWM7 pins are NOT 5 volt tolerant, so a 1K Ohm resistor is required between the sensor and the FC pins.
 186
 187 # Battery Monitoring Connections
 188
 189 | Pin  | Signal | Function        |
 190 | ---- | ------ | --------------- |
 191 | PWM9 | PA4    | Battery Voltage |
 192 | PWM8 | PA7    | Current Meter   |
 193
 194 ## Voltage Monitoring
 195
 196 The Sparky has no battery divider cricuit, PWM9 has an inline 10k resistor which has to be factored into the resistor calculations.
 197 The divider circuit should eventally create a voltage between 0v and 3.3v (MAX) at the MCU input pin.
 198
 199 WARNING: Double check the output of your voltage divider using a voltmeter *before* connecting to the FC.
 200
 201 ### Example Circuit
 202
 203 For a 3Cell battery divider the following circuit works:
 204
 205 `Battery (+) ---< R1 >--- PWM9 ---< R2 >--- Battery (-)`
 206
 207 * R1 = 8k2 (Grey Red Red)
 208 * R2 = 2k0 (Red Black Red)
 209
 210 This gives a 2.2k for an 11.2v battery.  The `vbat_scale` for this divider should be set around `52`.
 211
 212 ## Current Monitoring
 213
 214 Connect a current sensor to PWM8/PA7 that gives a range between 0v and 3.3v out (MAX).